<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD><meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<title>Console Factories</title>
<style type="text/css">@import url("file:/home/moovida/rcpdevelopment/eclipse/configuration/org.eclipse.osgi/bundles/488/1/.cp/book.css");</style>
<style type="text/css">@import url("file:/home/moovida/rcpdevelopment/eclipse/configuration/org.eclipse.osgi/bundles/505/1/.cp/schema.css");</style>
</HEAD>
<BODY>
<H1 style="text-align:center">Console Factories</H1>
<p></p>
<h6 class="CaptionFigColumn SchemaHeader">Identifier: </h6>org.eclipse.ui.console.consoleFactories<p></p>
<h6 class="CaptionFigColumn SchemaHeader">Since: </h6>3.1
<p></p>

<h6 class="CaptionFigColumn SchemaHeader">Description: </h6>A console factory creates or activates a console, and appears as an action in the console view.<p></p>
<h6 class="CaptionFigColumn SchemaHeader">Configuration Markup:</h6>
<p></p>
<p class="code SchemaDtd">&lt;!ELEMENT <a name="e.extension">extension</a> (<a href="#e.consoleFactory">consoleFactory</a>)&gt;</p>
<p class="code SchemaDtd">&lt;!ATTLIST extension</p>
<p class="code SchemaDtdAttlist">point&nbsp;CDATA #REQUIRED</p><p class="code SchemaDtdAttlist">id&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED</p><p class="code SchemaDtdAttlist">name&nbsp;&nbsp;CDATA #IMPLIED</p>&gt;</p>
<p></p>
<ul class="ConfigMarkupAttlistDesc">
<li><b>point</b> - a fully qualified identifier of the target extension point</li>
<li><b>id</b> - an optional identifier of the extension instance</li>
<li><b>name</b> - an optional name of the extension instance</li>
</ul>
<br><p class="code SchemaDtd">&lt;!ELEMENT <a name="e.consoleFactory">consoleFactory</a> EMPTY&gt;</p>
<p class="code SchemaDtd">&lt;!ATTLIST consoleFactory</p>
<p class="code SchemaDtdAttlist">label&nbsp;CDATA #REQUIRED</p><p class="code SchemaDtdAttlist">icon&nbsp;&nbsp;CDATA #IMPLIED</p><p class="code SchemaDtdAttlist">class&nbsp;CDATA #REQUIRED</p>&gt;</p>
<p></p>
<ul class="ConfigMarkupAttlistDesc">
<li><b>label</b> - action label to appear in menu</li>
<li><b>icon</b> - optional plug-in relative path to an icon to appear with the action</li>
<li><b>class</b> - class implementing <code>org.eclipse.ui.console.IConsoleFactory</code> that will be called when the associated action is invoked</li>
</ul>
<br><h6 class="CaptionFigColumn SchemaHeader">Examples: </h6>The following is an example of a console factory extension point: 
<pre class="Example"><span class="code SchemaTag">
&lt;extension point=</span><span class="code SchemaCstring">&quot;org.eclipse.ui.console.consoleFactories&quot;</span><span class="code SchemaTag">&gt;
  &lt;consoleFactory 
     label=</span><span class="code SchemaCstring">&quot;Command Console&quot;</span><span class="code SchemaTag">
     class=</span><span class="code SchemaCstring">&quot;com.example.CommandConsoleFactory&quot;</span><span class="code SchemaTag">
     icon=</span><span class="code SchemaCstring">&quot;icons/cmd_console.gif&quot;</span><span class="code SchemaTag">&gt;
  &lt;/consoleFactory&gt;
&lt;/extension&gt;
</span></pre>
This extension will cause an entry to appear in the console view's <b>Open Console</b> drop-down menu labelled <b>Command Console</b> with the specified icon. When the action is invoked by a user, the method <b>openConsole()</b> on the class <b>com.example.CommandConsoleFactory</b> will be called. The factory can the decide to create a new console or activate an existing console.
<p></p>

<h6 class="CaptionFigColumn SchemaHeader">API Information: </h6>Value of the attribute <b>class</b> must be a fully qualified name of a Java class that implements the interface <b>org.eclipse.ui.console.IConsoleFactory</b>.
<p></p>

<h6 class="CaptionFigColumn SchemaHeader">Supplied Implementation: </h6>The console plug-in provides a console factory to open a new console view.
<p></p>

<br>
<p class="note SchemaCopyright">
Copyright (c) 2004, 2005 IBM Corporation and others.<br>
All rights reserved. This program and the accompanying materials are made 
available under the terms of the Eclipse Public License v1.0 which 
accompanies this distribution, and is available at 
<a href="http://www.eclipse.org/legal/epl-v10.html">http://www.eclipse.org/legal/epl-v10.html</a>

</p>
</BODY>
</HTML>
